core/androidx.core.view/[main]WindowInsetsControllerCompat

WindowInsetsControllerCompat

class WindowInsetsControllerCompat(source)

Provide simple controls of windows that generate insets. For SDKs >= 30, this class is a simple wrapper around WindowInsetsController. For lower SDKs, this class aims to behave as close as possible to the original implementation.

Constructors

constructor(@NonNull window: Window, @NonNull view: View)

Types

OnControllableInsetsChangedListener

interface OnControllableInsetsChangedListener

Listener to be notified when the set of controllable WindowInsetsCompat.Type controlled by a WindowInsetsController changes.

Properties

BEHAVIOR_DEFAULT

val BEHAVIOR_DEFAULT: Int = 1

The default option for setSystemBarsBehavior: Window would like to remain interactive when hiding navigation bars by calling hide or setInsetsAndAlpha.

BEHAVIOR_SHOW_BARS_BY_SWIPE

val ~~BEHAVIOR_SHOW_BARS_BY_SWIPE~~: Int = 1

Option for setSystemBarsBehavior: Window would like to remain interactive when hiding navigation bars by calling hide or setInsetsAndAlpha.

BEHAVIOR_SHOW_BARS_BY_TOUCH

val ~~BEHAVIOR_SHOW_BARS_BY_TOUCH~~: Int = 0

Option for setSystemBarsBehavior.

BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE

val BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE: Int = 2

Option for setSystemBarsBehavior: Window would like to remain interactive when hiding navigation bars by calling hide or setInsetsAndAlpha.

Functions

addOnControllableInsetsChangedListener

open fun addOnControllableInsetsChangedListener(@NonNull listener: WindowInsetsControllerCompat.OnControllableInsetsChangedListener)

Adds a WindowInsetsController.OnControllableInsetsChangedListener to the window insets controller.

controlWindowInsetsAnimation

open fun controlWindowInsetsAnimation(types: Int, durationMillis: Long, @Nullable interpolator: Interpolator, @Nullable cancellationSignal: CancellationSignal, @NonNull listener: WindowInsetsAnimationControlListenerCompat)

Lets the application control window inset animations in a frame-by-frame manner by modifying the position of the windows in the system causing insets directly using setInsetsAndAlpha in the controller provided by the given listener.

getSystemBarsBehavior

open fun getSystemBarsBehavior(): Int

Retrieves the requested behavior of system bars.

hide

open fun hide(types: Int)

Makes a set of windows causing insets disappear.

isAppearanceLightNavigationBars

open fun isAppearanceLightNavigationBars(): Boolean

Checks if the foreground of the navigation bar is set to light.

isAppearanceLightStatusBars

open fun isAppearanceLightStatusBars(): Boolean

Checks if the foreground of the status bar is set to light.